﻿//--------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------
// Copyright 2012 Microsoft Corporation. All Rights Reserved
// Licensed under the Apache License, Version 2.0 (the "License"); you may not use this file except in compliance with the License.   
// You may obtain a copy of the License at
// http://www.apache.org/licenses/LICENSE-2.0
// Unless required by applicable law or agreed to in writing, software distributed under the License is distributed on an "AS IS" BASIS, WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. See the License for the specific language governing permissions and limitations under the License.
//--------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------

namespace Preflight.Verifications
{
    /// <summary>
    /// Describes a verification
    /// </summary>
    public abstract class VerificationDescription
    {
        /// <summary>
        /// Gets or Sets verification name
        /// </summary>
        public string VerificationName
        {
            get;
            set;
        }

        /// <summary>
        /// Gets or Set verification category
        /// </summary>
        public string Category
        {
            get;
            set;
        }

        /// <summary>
        /// Verifies that all required values for the verification to work have been provided
        /// </summary>
        public void Validate()
        {
            if (string.IsNullOrWhiteSpace(this.VerificationName))
            {
                Log.LogError("Verification name is missing");
                throw new MissingDescriptionValueException("VerificationName");
            }

            if (string.IsNullOrWhiteSpace(this.Category))
            {
                Log.LogError("Verification category is missing");
                throw new MissingDescriptionValueException("Category");
            }

            this.ValidateState();
        }

        protected virtual void ValidateState()
        {
        }
    }
}